一、应用场景
视频设备业务接口是物联网平台提供用于客户对视频事件进行业务操作的API。开发者可以使用视频事件业务相关接口,进行查询视频事件列表以及查看视频事件图片等业务操作。开发者此类接口可实现如下业务场景:
二、功能说明
事件业务接口主要包含以下几种:
查询事件列表
查询事件类型
三、前提条件
参考管理台设备部署手册《视频设备部署操作手册》,确保在管理台【设备中心】中完成对设备的接入上线;
设备已经配置到项目上。
如果是阿里IOT来源的设备,需要配置对应的appKey与appSecret。详情请看
四、关键流程
无
五、API列表
1、视频事件业务接口
1.1、事件列表
接口描述
应用于对视频事件列表的查询
请求方式
POST
请求地址
/v3/service/video-surveillance/projects/video-events
请求头
名称 | 必填 | 类型 | 备注 |
---|---|---|---|
Access-Token | true | String | 访问Token(B端用户权限) |
Content-Type | true | String | application/json |
body请求参数
名称 | 必填 | 类型 | 备注 |
---|---|---|---|
offset | true | int | 开始页码 |
limit | true | int | 页大小 |
order | false | Object | 排序条件 |
query | false | Object | 过滤条件 |
请求示例:
{
"offset": 0,
"limit": 50,
"order": {
"create_time": "desc"
},
"query":{
"project_id":{
"$eq":"项目ID"
}
}
}
返回参数说明
名称 | 必填 | 类型 | 备注 |
---|---|---|---|
code | true | string | 响应码, 成功状态码为000000,其他为异常码 |
data | true | object | 响应数据 |
data.count | true | integer | 返回总数 |
data.list | true | array | 返回列表 |
data.list.biz_organizations_area_id_level1 | false | string | 事件所属项目片区ID |
data.list.device_id | false | integer | 事件触发设备ID |
data.list.device_location | false | string | 设备位置 |
data.list.device_location_detail | false | string | 设备详细位置 |
data.list.device_mac | false | string | 设备mac地址 |
data.list.device_name | false | string | 事件触发设备名称 |
data.list.event_code | false | string | 事件码 |
data.list.event_desc | false | string | 事件描述 |
data.list.event_level | false | string | 事件等级 |
data.list.event_level_id | false | string | 事件级别id |
data.list.event_name | false | string | 源事件名称(也是事件类型的触发条件) |
data.list.event_state | false | integer | 事件状态(处理状态)//未处理NO_HANDLE(1),//处理中HANDLING(2),//已处理HANDLED(3),``//误报MISSINFO(9), |
data.list.event_type_classification_id | false | string | 事件类型分类ID |
data.list.event_type_classification_name | false | string | 事件类型分类名称 |
data.list.event_type_id | false | string | 事件类型ID |
data.list.event_type_name | false | string | 事件类型名称 |
data.list.handled_time | false | date | 已处理时间, 0时区标准格式 |
data.list.id | false | string | id |
data.list.is_order | false | boolean | 是否转工单 |
data.list.pic_url | false | string | 图片url |
data.list.publish_source | false | integer | 上报类型(上报来源)//自动上报AUTO(1),//人工上报MANUAL(2), |
data.list.supplier | false | string | 供应商 |
data.list.time | false | string | 事件触发的时间 |
data.list.video_url | false | string | 视频url |
data.list.events | false | List | 聚合的事件数据集 |
data.list.pics | false | List | 聚合的事件图片数据集 |
msg | true | string | 响应消息 |
status | true | string | 响应状态 |
错误码
无
1.2、查询事件类型
接口描述
应用于对视频事件列表的查询
请求方式
POST
请求地址
/v3/service/video-surveillance/projects/video-events
请求头
名称 | 必填 | 类型 | 备注 |
---|---|---|---|
Access-Token | true | String | 访问Token(B端用户权限) |
Content-Type | true | String | application/json |
body请求参数
名称 | 必填 | 类型 | 备注 |
---|---|---|---|
offset | true | int | 开始页码 |
limit | true | int | 页大小 |
order | false | Object | 排序条件 |
query | false | Object | 过滤条件 |
请求示例:
{
"limit": 999,
"offset": 0,
"query": {
"classification_id": {
"$eq": "事件分类ID"
}
}
}
返回参数说明
名称 | 必填 | 类型 | 备注 |
---|---|---|---|
code | true | string | 响应码, 成功状态码为000000,其他为异常码 |
data | true | object | 响应数据 |
data.count | false | Long | 数据集长度 |
data.list | false | Array | 数据集 |
data.list.application | true | String | 应用名称 |
data.list.classification_id | true | String | 事件分类ID |
data.list.classification_name | true | String | 事件分类名称 |
data.list.corp_id | true | String | 企业ID |
data.list.id | true | String | 事件类型ID |
data.list.name | true | String | 事件类型名称 |
data.list.priority | true | Integer | 优先级 |
data.list.project_required | true | Boolean | 是否项目共享 |
data.list.rank_id | true | String | 事件级别ID |
错误码
无